home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / vfam114.zip / FILEX.DOC < prev    next >
Text File  |  1991-05-10  |  12KB  |  304 lines
  1.  
  2.                           FILEX Version 1.10
  3.                         written by Bill Auclair
  4.                         Opus/FidoNet 1:141/545
  5.                   (C) 1990,1991 by XanSoft Development
  6.                           ALL RIGHTS RESERVED
  7.  
  8.  
  9.  
  10. DISCLAIMER-
  11.  
  12.      FILEX is guaranteed to do nothing more than decrease your hard
  13.      drive space by one files' worth.  The author shall not be held
  14.      liable for any damages resulting from the use or misuse of this
  15.      software program.  You are cautioned to use this program at your
  16.      own risk.
  17.  
  18.  
  19. DESCRIPTION-
  20.  
  21.      FILEX is a software program designed to facilitate the maintenance
  22.      of file areas on Opus<tm> v1.0x ,1.1x and other compatible BBSes.
  23.      It was written to be used with a companion utility, a file area
  24.      management program called VersaFAM.  Latest versions of both FILEX and
  25.      VersaFAM may be obtained from the author's BBS (FidoNet 1:141/545).
  26.  
  27.      FILEX is used to add new files to file areas.  Easily invoked from
  28.      the DOS command line, it transports specified files to target file
  29.      areas and automagically updates the list file for those areas,
  30.      optionally supplying a description to be used in the list file.
  31.  
  32.      FILEX fully supports the use of DOS wildcards * and ?, allowing
  33.      for mass additions of files to file areas.  FILEX can also be
  34.      invoked from a batch file, to handle the addition of periodic
  35.      files (FidoNews, nodediffs, etc.) into file areas.
  36.  
  37.      FILEX versions 1.07c and later now use an optional configuration file,
  38.      named FILEX.DAT.  FILEX.DAT can be used to exclude additional filenames
  39.      from update processing, and will be used for other purposes in future
  40.      updates.  When invoked, FILEX will look for FILEX.DAT in the directory
  41.      pointed to by the FILEX environmental variable.  If the FILEX variable
  42.      is not defined, FILEX will look for FILEX.DAT in the current directory.
  43.      If no FILEX.DAT file is found, processing continues normally.
  44.  
  45.      The use of DOS wildcards (*) and (?) is NOT supported when using the
  46.      EXCLUDE verb in FILEX.DAT.  A maximum of 256 filenames may be optionally
  47.      excluded from update processing.
  48.  
  49.      The QUIET configuration file verb may be used to disable the display of
  50.      individual filenames during FILEX processing, reducing program execution
  51.      time by 30 to 50 percent.
  52.  
  53.      List file names other than the default FILES.BBS are now supported by
  54.      FILEX.  If you wish to process a list file other than FILES.BBS, simply
  55.      enter the list file name after the LISTFILE verb in FILEX.DAT.
  56.  
  57.      The BIOS configuration verb can be used to choose between fast direct or
  58.      slower BIOS-based video output.
  59.  
  60.  
  61.      FILEX Version 1.10             - 2 -
  62.  
  63.      FILEX versions 1.05 and later now support the use of macros
  64.      within file descriptions.  The following description macros
  65.      are available:
  66.  
  67.        [DATE]    gives current date in MM/DD/YY format.
  68.        [TIME]    gives current time in HH:MM format.
  69.        [YEAR]    gives verbose listing of current year.
  70.        [MONTH]   gives verbose listing of current month.
  71.        [DAY]     gives verbose listing of current day of the week.
  72.        [0]-[15]  sets OEC (Opus Embedded Code) text colors
  73.        [B]       enables blinking
  74.  
  75.  
  76.  
  77.  
  78.  
  79. OEC COLOR CODES-
  80.  
  81.      FILEX versions 1.05 and later now support the use of macro OEC
  82.      (Opus Embedded Codes) to change the color of file description text.
  83.      The key for these macros is shown below:
  84.  
  85.  
  86.               [0]  Black              [8]  Dark Gray
  87.               [1]  Blue               [9]  Light Blue
  88.               [2]  Green              [10] Light Green
  89.               [3]  Cyan               [11] Light Cyan
  90.               [4]  Red                [12] Light Red
  91.               [5]  Magenta            [13] Light Magenta
  92.               [6]  Brown              [14] Yellow
  93.               [7]  Light Gray         [15] White
  94.  
  95.      Inserting a [B] after any of the macros above will cause the
  96.      text to blink when the OEC codes are interpreted.  Blinking
  97.      will continue until another color code is encountered.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104. INSTALLATION-
  105.  
  106.      FILEX should ideally be installed in a subdirectory included in
  107.      your DOS PATH statement.  This will ensure that the program can
  108.      be executed no matter which subdirectory you happen to be in.
  109.  
  110.  
  111.  
  112.      FILEX Version 1.10            - 3 -
  113.  
  114. OPERATION-
  115.  
  116.      FILEX accepts the following command line syntax:
  117.  
  118.      ------------------------------------------------------------------
  119.      FILEX [<source path>] [<target path>] [<description>]
  120.      ------------------------------------------------------------------
  121.  
  122.      EXAMPLES
  123.  
  124.      Suppose you have the file PACMAN.ARC in subdirectory
  125.      C:\TEST.  You want to add this file to a file area using
  126.      subdirectory C:\FILE\GAMES, with a suitable description.  The
  127.      command line syntax used for this example is shown below:
  128.  
  129.  
  130.      ------------------------------------------------------------------
  131.      FILEX c:\test\pacman.arc c:\file\games PAC_MAN_Arcade_Game
  132.      ------------------------------------------------------------------
  133.      Note the use of underscores between the words in the description.
  134.      Underscores MUST be used, or the description will not be correctly
  135.      interpreted by the FILEX command line parser.
  136.  
  137.      Suppose you've gotten in a bunch of programming files, all with
  138.      .ZIP extensions, that you'd like to transfer to your Programming
  139.      file area.  You don't care about file area descriptions, you'll
  140.      use VersaFAM to fill them in later. You just need them included
  141.      in the list file with a "generic" description.  The command line
  142.      syntax used for this example is shown below:
  143.  
  144.  
  145.  
  146.      ------------------------------------------------------------------
  147.      FILEX c:\test\*.zip c:\file\program
  148.      ------------------------------------------------------------------
  149.      This transfers all files in C:\TEST with a .ZIP extension to
  150.      C:\FILE\PROGRAM, updating C:\FILE\PROGRAM\FILES.BBS.  When a
  151.      description is not supplied on the command line, FILEX defaults
  152.      to a description of "<Description Unavailable>" for all files.
  153.  
  154.      If the directory from which FILEX is invoked and the target
  155.      subdirectory are the same, the target subdirectory need not be
  156.      specified on the command line:
  157.  
  158.  
  159.  
  160.      FILEX Version 1.10              - 4 -
  161.  
  162.      ------------------------------------------------------------------
  163.      FILEX *.arc
  164.      ------------------------------------------------------------------
  165.      will add all files in C:\FILE\MUSIC with an .ARC extension to
  166.      C:\FILE\MUSIC\FILES.BBS, supplying a generic description, if FILEX
  167.      is called from C:\FILE\MUSIC.  If a non-generic description is to
  168.      be supplied to the files in this example, the hyphen (-) character
  169.      should be used as a "placeholder" to indicate that the current and
  170.      target subdirectories are the same:
  171.  
  172.  
  173.  
  174.      ------------------------------------------------------------------
  175.      FILEX *.arc - New_Music_Files
  176.      ------------------------------------------------------------------
  177.      will add all files in C:\FILE\MUSIC with an .ARC extension to
  178.      C:\FILE\MUSIC\FILES.BBS, using the description supplied on the
  179.      command line, if FILEX is called from C:\FILE\MUSIC.
  180.  
  181.  
  182.  
  183.      ------------------------------------------------------------------
  184.      FILEX fnews???.* d:\newsletr FidoNews,_rec'd_[DATE]_at_[TIME]
  185.      ------------------------------------------------------------------
  186.      will add any existing FidoNews files to D:\NEWSLETR\FILES.BBS,
  187.      using macros to insert a date/time stamp corresponding to when
  188.      the file was processed.
  189.  
  190.  
  191.  
  192.      ------------------------------------------------------------------
  193.      FILEX blah.exe c:\newstuff [15][B]New_Files_[3]as_of_[DATE]
  194.      ------------------------------------------------------------------
  195.      will add the file BLAH.EXE to C:\NEWSTUFF\FILES.BBS, with the words
  196.      "New Files" blinking white in the description, and the rest of the
  197.      line shown in non-blinking cyan.
  198.  
  199.  
  200.  
  201.  
  202.      When FILEX is run, the first thing it does is check each target
  203.      file against files already listed in the list file for the target
  204.      subdirectory.  If it finds the target file(s) already listed
  205.      in the list file, it does NOT add the target file(s).  If the specified
  206.      list file is not found in the target subdirectory, one is created.
  207.  
  208.      Based on feedback from users, use of the FILEX.OPS log file has been
  209.      discontinued in FILEX versions 1.10 and later.  The FILEX environmental
  210.      variable may still be used to point to the FILEX.DAT file.
  211.      A typical environmental variable listing is shown below:
  212.  
  213.  
  214.                             set FILEX=c:\utility
  215.  
  216.  
  217.  
  218.      FILEX Version 1.10            - 5 -
  219.  
  220.  
  221. NON-PROCESSABLE FILES-
  222.  
  223.      Certain file names and extensions are ignored by FILEX when it is
  224.      processing target files.  These filenames include:
  225.  
  226.                               DIR.BBS
  227.                               DIR.BAK
  228.                               FILES.BBS
  229.                               FILES.BAK
  230.                               FILEX.DAT
  231.                               FILEX.EXE
  232.                               COMn
  233.                               LPTn
  234.                               PRN
  235.                               CON
  236.                               SCRN
  237.                               NUL
  238.  
  239.  
  240.  
  241.  
  242. REVISION HISTORY-
  243.  
  244.      1/4/90:     Version 1.03
  245.                  First public non-beta release
  246.  
  247.      3/22/90:    Version 1.05
  248.                  Added description macros [DATE],[TIME],[YEAR],[MONTH],
  249.                  [DAY],[0] thru [15] and [B].  Also added support for
  250.                  the FILEX environment variable, and changed FILEX.OPS
  251.                  log file to append, rather than rewrite the log file
  252.                  each time the program is run.
  253.  
  254.      7/4/90:     Version 1.06
  255.                  Fixed bug that caused FILEX to duplicate existing file
  256.                  entries when those entries did not have a file
  257.                  extension.  Changed blank padding between filenames
  258.                  and descriptions from 1 space to 2 spaces, in order to
  259.                  conform with Opus/Maximus norms.  Increased list file
  260.                  read capacity to 1024 lines to conform with VersaFAM
  261.                  file area manager specifications.
  262.  
  263.      11/28/90:   Version 1.07a (beta)
  264.                  Fixed a glitch that was generating "Invalid Command Line"
  265.                  errors for those running 4DOS by replacing the " placeholder
  266.                  character with the hyphen (-) character instead.
  267.  
  268.  
  269.  
  270.      FILEX Version 1.10                 - 6 -
  271.  
  272.      12/5/90:    Version 1.07b (beta)
  273.                  Revised handling of filename string to avoid duplication of
  274.                  FILES.BBS info when processing lowercase filenames.
  275.  
  276.      12/29/90:   Version 1.07c (beta)
  277.                  Added FILEX.DAT configuration file, with EXCLUDE verb, to
  278.                  allow users to specify additional filenames to be excluded
  279.                  from processing.
  280.  
  281.       1/13/91:   Version 1.07d (beta)
  282.                  Added code to configuration file routines to change TAB
  283.                  characters to spaces when encountered.
  284.  
  285.       2/24/91:   Version 1.08
  286.                  Added QUIET configuration file verb and functions.  Added
  287.                  variable listfile name option.  Removed FILEX.OPS log file
  288.                  option.  Added BIOS configuration file verb.  Generally
  289.                  cleaned up code, optimizing for speed.
  290.  
  291.       5/10/91:   Version 1.10
  292.                  Added "smart" dynamic memory allocation to allow execution
  293.                  in as little as 140K RAM.  FILEX will exit with an error 
  294.                  message if insufficient RAM memory is available.
  295.  
  296.  
  297.      Please address all comments, criticisms and bug reports to:
  298.  
  299.                             Bill Auclair
  300.                             1:141/545.0
  301.  
  302.      Thanks a lot.  Hope you get as much enjoyment out of this program
  303.      as I got in bringing it to you....
  304.